Improve typing-time lazy import behaviors to expose attribute errors to type checkers #1052
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ensure that a missing name gets a type-error, meaning that the getattr importer hasn't obscured other errors.
Move the definitions of `__getattr__` and `__dir__` into the `else` block of the `if TYPE_CHECKING` directive, meaning that they are not evaluated at typing time. Doing so forces `mypy` to evaluate the listed imports as though they were the only things in the module, and to treat them and the `__all__` list as a canonical listing of top-level `globus_sdk` attributes. As a result, previously undetectable errors (such as a bad module-attribute name) are properly detected. Without this characteristic, `mypy` sees the `__getattr__` method and assumes that any module attribute access will be valid.
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus and
kurtmckee
as code owners
kurtmckee
approved these changes
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Basically, the three commits are:
mypyversion📚 Documentation preview 📚: https://globus-sdk-python--1052.org.readthedocs.build/en/1052/